Double-Take Availability Scripting Guide Printable Version
This document is a single HTML page that contains all of the separate HTML pages in the Double-Take Availability Scripting Guide. This single HTML document is designed to make printing the entire Scripting Guide easier. You can also print sections of the Scripting Guide by using your browser's print preview feature and printing only the desired pages. Keep in mind that the page numbers as seen in the Table of Contents may not match the page numbers when you print the document because of differences in printer configurations.
This printable document is not a standalone document. It requires the style definition files and graphic files used in the separate-page Scripting Guide. Therefore, if you try to view or print this document on its own (for example, by copying or downloading the single file to a different location), the output will not have any formatting or graphics included.
Table of Contents
| Welcome to the Double-Take Availability Scripting Guide | |
| Getting started | |
| Frequently used pages | |
| Printable Version | |
| Resources | |
| Legal | |
| Client and scripts | |
| Command Line client | |
| Scripts | |
| Command syntax conventions | |
| Getting help for scripting commands | |
| Replication sets | |
| Creating a replication set | |
| Modifying a replication set | |
| Deleting a replication set | |
| Calculating replication set size | |
| Establishing a connection | |
| Simulating a connection | |
| Connections | |
| Monitoring connections | |
| Queuing Double-Take Availability data | |
| Reconnecting automatically | |
| Pausing and resuming target processing | |
| Disconnecting a connection | |
| Mirroring | |
| Stopping, starting, pausing, or resuming mirroring | |
| Mirroring automatically | |
| Removing orphan files | |
| Replication | |
| Starting replication | |
| Inserting tasks during replication | |
| Verifying your target data | |
| Data transmission | |
| Stopping, starting, pausing, and resuming transmission | |
| Scheduling data transmission | |
| Transmission schedule examples | |
| Limiting transmission bandwidth | |
| Compressing data for transmission | |
| Restoring data | |
| Failover | |
| Configuring failover monitoring | |
| Editing failover monitoring configuration | |
| Failing over | |
| Stopping failover monitoring | |
| Deleting failover monitoring configuration | |
| Failing back | |
| Configuring server settings | |
| Server settings | |
| Scripting examples | |
| Creating and connecting a replication set | |
| Creating and connecting a replication set with failover monitoring | |
| Restoring a replication set | |
| Using variables to create and connect a replication set and run verification | |
| Controlling a mirror using flow control | |
| Using variables to pause a target | |
| Using variables to resume a target | |
| Creating a backup or snapshot of the target by inserting a task command during replication | |
| Creating a backup of the target by rotating connections | |
| Scripting commands | |
| Compression Disable | |
| Compression Enable | |
| Compression List | |
| Compression Set | |
| ConID | |
| Connect | |
| Connect TDU | |
| Device List | |
| Disconnect | |
| Email Add | |
| Email Disable | |
| Email Enable | |
| Email Filter | |
| Email From Address | |
| Email Get Email Config | |
| Email Mail Server | |
| Email Remove | |
| Email Set Filter Include | |
| Email Subject | |
| Email Test | |
| Environment | |
| Exit | |
| Failback | |
| Failover | |
| Get | |
| GetEnvStr | |
| Get Local | |
| Help | |
| Limit Bandwidth | |
| Load Source | |
| Load Target | |
| Login | |
| Logout | |
| Mirror Pause | |
| Mirror Resume | |
| Mirror Start | |
| Mirror Stop | |
| Monitor Account Add | |
| Monitor Account Remove | |
| Monitor Clear | |
| Monitor Create | |
| Monitor Delete | |
| Monitor Display | |
| Monitor Get | |
| Monitor List | |
| Monitor Move | |
| Monitor Option | |
| Monitor Remove | |
| Monitor Script Add | |
| Monitor Script Remove | |
| Monitor Start | |
| Monitor Stop | |
| Monitor Use | |
| NIC List | |
| Orphans Disable | |
| Orphans Enable | |
| Orphans Start | |
| Orphans Stop | |
| Pause Target | |
| Ping | |
| Queue Task | |
| Quit | |
| Replication Start | |
| Replication Stop | |
| Repset Calculate | |
| Repset Create | |
| Repset Delete | |
| Repset Display | |
| Repset List | |
| Repset Resync | |
| Repset Rule Add | |
| Repset Rule Remove | |
| Repset Save | |
| Repset Use | |
| Restore | |
| Resume Target | |
| Schedule Clear | |
| Schedule Disable | |
| Schedule Enable | |
| Schedule End | |
| Schedule Start | |
| Schedule Window | |
| Set | |
| Set Local | |
| Shutdown | |
| Source | |
| StatsLog Start | |
| StatsLog Status | |
| StatsLog Stop | |
| Status | |
| Target | |
| Test Connections | |
| Time Now | |
| Transmission Pause | |
| Transmission Resume | |
| Transmission Start | |
| Transmission Stop | |
| Unload Source | |
| Unload Target | |
| Verify | |
| Version | |
| Wait | |
| Wait on Mirror | |
| Wait on Restore | |
| Wait on Target | |
| Write | |
This online documentation is designed to help you find detailed information about the Double-Take scripting language. Use the Contents pane on the left to explore the different sections or use Search or Index to find specific topics. Below are some of the most useful and most accessed topics in the online documentation.
If you are using Internet Explorer and are getting an active content blocker pop-up in your browser, you need to enable active content to run in files on your computer. From Internet Explorer, select Tools, Internet Options. On the Advanced tab, enable Allow active content to run in files on My Computer.
A printable version, which is a single HTML page containing all of the separate HTML pages in the Double-Take Availability Scripting Guide, is available. This single HTML document is designed to make printing the entire Scripting Guide easier.
Double-Take, Balance, Double-Take Availability, Double-Take Backup, Double-Take Cargo, Double-Take Flex, Double-Take for Hyper-V, Double-Take for Linux, Double-Take Move, Double-Take ShadowCaster, Double-Take for Virtual Systems, GeoCluster, Livewire, netBoot/i, NSI, sanFly, TimeData, TimeSpring, winBoot/i and associated logos are registered trademarks or trademarks of Double-Take Software, Inc. and/or its affiliates and subsidiaries in the United States and/or other countries. Microsoft, Hyper-V, Windows, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. All other trademarks are the property of their respective companies.
© 1996-2010 Double-Take Software, Inc. All rights reserved.
Double-Take Availability has its own scripting language to control some, but not all Double-Take Availability features. This Scripting Guide does not explain Double-Take Availability features and functions, only the scripting aspects of Double-Take Availability. For details on the features and functions, see the Double-Take Availability User's Guide.
The scripting language can be used in the Double-Take Availability Command Line client or in script files. The client and script files use the same set of commands.
This section includes the following topics.
There are three different methods of executing commands from the Command Line client.
|
C:\Program Files\DoubleTake> dtcl -i Command: login alpha administrator ******* domain_name User access level set to DT_FULL_ACCESS Command: |
|
C:\Program Files\DoubleTake> type dtcl.txt login alpha administrator password domain; source alpha; repset list;
C:\Program Files\DoubleTake> dtcl -f dtcl.txt User access level set to DT_FULL_ACCESS - List of rep sets - DataFiles enabled
C:\Program Files\DoubleTake> |
|
C:\Program Files\DoubleTake> dtcl login alpha administrator password domain; source alpha; repset list User access level set to DT_FULL_ACCESS - List of rep sets - DataFiles enabled
C:\Program Files\DoubleTake> |
| Note: | If you are using the Windows command process (cmd.exe), it strips two layers of quotation marks during processing, any scripting command that you use that requires quotation marks must have three quotation marks around it. For example, if your machine name had a space in it, login "machine name" username password would be sufficient for the Command Line client interactive entry or file entry. But for the Command Line client single line entry, you would have to use login """machine name""" username password. |
You can create script files to execute series and combinations of scripting commands to meet specific needs. When working with scripts, keep in mind the following.
IF <relational expression> THEN <statement_block> [ ELSE <statement_block> ] END
Use the following conditions to create the relational expression.
| = | equal to |
| != | not equal to |
| < | less than |
| <= | less than or equal to |
| > | greater than |
| >= | greater than or equal to |
| statement block | any sequence of valid commands |
FOR <variable> = <start_value> TO <end_value> [STEP <step_value>] DO <statement_block> END
WHILE <relational_expression> DO <statement_block> END
cmd /c DTCL -f "C:\Program Files\DoubleTake\scriptname.txt"
If you do not specify a path for the script file, Double-Take Availability will look in the directory where the DTCL -f command was executed.
The following conventions are used for the scripting commands.
| Note: |
You can specify an IP address or an IP address:port combination (separated by a colon) in place of a machine name in any DTCL command that allows for the entry of a machine name. For example, all of the following login commands are acceptable.
If you have modified your ports so that your source, target and/or clients are running on different ports and you are using DTCL scripts, then you will need to modify the scripts to include the port values as noted above. This only applies to source/target/client combinations that are communicating with each other on different ports. |
A listing of the DTCL commands and their syntax is available by typing the
| Command | HELP |
| Description | Displays the DTCL commands and their syntax |
| Syntax | HELP |
| Notes |
|
Using the scripting commands, you can perform the following functions to manage your replication sets.
Before you can establish a connection, you must create a replication set.
| Command | REPSET CREATE |
| Description | Creates a replication set |
| Syntax | REPSET CREATE <name> |
| Options | name—Name of the replication set |
| Examples | repset create DataFiles |
| Notes |
|
| Command | REPSET USE |
| Description | Specifies a replication set as the active replication set |
| Syntax | REPSET USE <repset> |
| Options | repset—Name of the replication set |
| Examples | repset use DataFiles |
| Notes | Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | REPSET RULE ADD |
| Description | Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names. |
| Syntax | REPSET RULE ADD <path> [INClude|EXClude] [, RECursive|NONRECursive] [TO <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | DEVICE LIST |
| Description | Displays the block devices available on a machine |
| Syntax | DEVICE LIST <filter> [ON <machine>] |
| Options |
|
| Examples |
device list all on alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | REPSET RULE REMOVE |
| Description | Removes a rule from a replication set |
| Syntax | REPSET RULE REMove <path> [FROM <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | REPSET SAVE |
| Description | Saves all replication set rules for the currently selected source |
| Syntax | REPSET SAVE |
Make modifications to a replication set when you want to change the data you wish to protect.
| Command | REPSET LIST |
| Description | Lists all replication set names for the currently selected source |
| Syntax | REPSET LIST |
| Command | REPSET USE |
| Description | Specifies a replication set as the active replication set |
| Syntax | REPSET USE <repset> |
| Options | repset—Name of the replication set |
| Examples | repset use DataFiles |
| Notes | Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | REPSET DISPLAY |
| Description | Displays the replication set rules |
| Syntax | REPSET DISPlay [repset] |
| Options | repset—Name of the replication set |
| Examples |
|
| Notes |
|
| Command | REPSET RULE REMOVE |
| Description | Removes a rule from a replication set |
| Syntax | REPSET RULE REMove <path> [FROM <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | REPSET RULE ADD |
| Description | Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names. |
| Syntax | REPSET RULE ADD <path> [INClude|EXClude] [, RECursive|NONRECursive] [TO <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | REPSET RESYNC |
| Description | Retrieves the last saved replication set settings, clearing any unsaved changes |
| Syntax | REPSET RESYNC |
| Command | REPSET SAVE |
| Description | Saves all replication set rules for the currently selected source |
| Syntax | REPSET SAVE |
| Command | REPSET LIST |
| Description | Lists all replication set names for the currently selected source |
| Syntax | REPSET LIST |
| Command | REPSET DELETE |
| Description | Deletes the specified replication set |
| Syntax | REPSET DELete <repset> |
| Options | repset—Name of the replication set repset |
| Examples |
|
| Notes | Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | REPSET SAVE |
| Description | Saves all replication set rules for the currently selected source |
| Syntax | REPSET SAVE |
| Command | REPSET CALCULATE |
| Description | Calculates the size of a replication set |
| Syntax | REPSET CALCulate [repset] |
| Options | repset—Name of the replication set |
| Examples |
|
| Notes |
|
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
After you have created a replication set, you can establish a connection by connecting the replication set to a target.
| Command | REPSET LIST |
| Description | Lists all replication set names for the currently selected source |
| Syntax | REPSET LIST |
| Command | CONNECT |
| Description | Establishes a connection between a replication set and a target machine |
| Syntax | CONnect <repset> TO <target> MAP EXACT | MAP BASE <target_path> | MAP <source_path> TO <target_path> [,...] [MIRror | NOMIRror] [, REPlicate | NOREPlicate] [, MONitor | NOMONitor] [, ORPHANS | NOORPHANS] [, COMPRESSion <level>] [CLEARRESTOREREQUIRED] [ROUTE=<target_IP>] |
| Options |
|
| Examples |
|
| Notes |
|
After you have created a replication set, you can simulate a connection by connecting the replication set to the TDU.
| Command | REPSET LIST |
| Description | Lists all replication set names for the currently selected source |
| Syntax | REPSET LIST |
| Command | CONNECT TDU |
| Description | Establishes a simulation connection between a replication set and the Throughput Diagnostics Utility. This connection imitate a normal connection without transmitting any data across the network. |
| Syntax | CONNECT <repset> TO TDU <filename> [connection_flags] |
| Options |
|
| Examples |
|
| Notes |
|
Using the scripting commands, you can perform the following functions to manage your connections.
| Command | CONID |
| Description |
|
| Syntax |
|
| Options |
|
| Examples |
|
| Notes |
|
| Command | STATUS |
| Description | Requests connection and statistical information |
| Syntax | STATUS BLOCK [ON <target>] | CONnect <con_id> | MIRror <con_id> | REPlicate <con_id> | TRANsmit <con_id> |
| Options |
|
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
Use the
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
Use the AutoReconnect option with the
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | PAUSE TARGET |
| Description | Allows you to pause the execution of Double-Take Availability operations on the target |
| Syntax | PAUSETARGET <target> [FROM <source>] |
| Options |
|
| Examples | pausetarget beta |
| Notes |
|
| Command | RESUME TARGET |
| Description | Allows you to resume the execution of Double-Take Availability operations on the target |
| Syntax | RESUMETARGET <target> [FROM <source>] |
| Options |
|
| Examples | resumetarget beta |
| Notes |
|
Use the
| Command | DISCONNECT |
| Description | Disconnects a specified source/target connection for the currently selected source |
| Syntax | DISCONnect <con_id | *> |
| Options |
|
| Examples |
|
Using the scripting commands, you can perform the following functions to manage mirroring.
You can stop, start, pause, or resume a mirror.
| Command | MIRROR STOP |
| Description | Stops a mirror |
| Syntax | MIRror STOP <con_id | *> |
| Options |
|
| Examples |
|
| Command | MIRROR START |
| Description | Initiates the mirror process |
| Syntax | MIRror START <con_id> [DIFFERENT [,NEWER] ,CHECKSUM | NOCHECKSUM] [ORPHANS |NOORPHANS] [CALCulate | NOCALCulate] [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
| Notes | The default settings for this command are noorphans and calculate. |
| Command | MIRROR PAUSE |
| Description | Pauses a mirror that is in progress |
| Syntax | MIRror PAUSE <con_id | *> |
| Options |
|
| Examples |
|
| Command | MIRROR RESUME |
| Description | Resumes a paused mirror |
| Syntax | MIRror RESUME <con_id | *> |
| Options |
|
| Examples |
|
Use the AutoRemirror option with the
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | ORPHANS ENABLE |
| Description | Enables orphan file removal during subsequent mirror or verification processes. |
| Syntax | ORPHANS ENABLE con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans enable 1 |
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | ORPHANS DISABLE |
| Description | Disables orphan file removal during subsequent mirror or verification processes. |
| Syntax | ORPHANS DISABLE con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans disable 1 |
| Command | ORPHANS START |
| Description | Manual operation to remove any orphan files on the target |
| Syntax | ORPHANS START con_id [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples | orphans start 1 |
| Command | ORPHANS STOP |
| Description | Stops the process to remove orphan files on the target |
| Syntax | ORPHANS STOP con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans stop 1 |
Using the scripting commands, you can perform the following functions to manage replication.
Start replication by using the
| Command | REPLICATION START |
| Description | Initiates the replication process |
| Syntax | REPlication START <conid | *> [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
Task command processing is a Double-Take Availability feature that allows you to insert and run tasks at various points during the replication of data. Because the tasks are user-defined, you can achieve a wide variety of goals with this feature. For example, you might insert a task to create a snapshot or run a backup on the target after a certain segment of data from the source has been applied on the target. This allows you to coordinate a point-in-time backup with real-time replication.
Task command processing can be enabled from the Replication Console, but it can only be initiated through a scripting command.
If you disable this option on a source server, you can still submit tasks to be processed on a target, although task command processing must be enabled on the target.
Because Double-Take Availability replication follows the same write sequence within and across multiple files, it provides complete data integrity at all times. At any given moment, the target represents a single point in time from the source, which makes the target crash consistent. But for some applications, crash consistency may not be adequate. You may require that the source data be in a quiescent (latent) state, similar to an application checkpoint. You need to be able to identify when the application is stable, which is usually when all of the data has been written to disk. This can be triggered by stopping the service. With task command processing, you can stop the source service just long enough to identify that stopped point in time as a stable state, insert a task at that point into the Double-Take Availability replication queue to trigger a backup or snapshot on the target, and then restart the service. Here is how the process would work.
Double-Take Availability task command processing must be enabled, and there must be an active Double-Take Availability connection for task command processing to function properly. To insert a task command, you would use the
| Command | QUEUETASK |
| Description | Queues tasks inline with replication data |
| Syntax | QueueTASK <job_name> TO <target> ONQueue = <task> [args] | ONTRANSmit = <task> [args] | ONRECeive = <task> [args] | ONEXECute = <task> [args] [TIMEOUT = <timeout>] [INTERACT | NOINTERACT] |
| Options |
|
| Examples |
|
| Notes |
|
With scripting commands, verification can only be initiated after a connection is established.
| Command | LOGIN |
| Description | Log on to a Double-Take Availability machine |
| Syntax | LOGIN <machine> <username> <password> [domain] |
| Options |
|
| Examples | login alpha administrator ****** |
| Notes |
|
| Command | SOURCE |
| Description | Identifies a machine as the active source machine |
| Syntax | SOUrce <source> |
| Options | source—Name of the source |
| Examples |
|
| Notes | Source names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | VERIFY |
| Description | Verifies the integrity of the data between the source and target machines |
| Syntax | VERIFY <con_id> [ SYNC [,NEWER] | NOSYNC] [,CHECKSUM | NOCHECKSUM] [STARTTIME=<mm/dd/yy> [hh:mm]] [EVERY <number> <time_units>] [ORPHANS | NOORPHANS] [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
| Notes | The default verification settings are sync, checksum, and noorphans. |
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
Using the scripting commands, you can perform the following functions to manage your Double-Take Availability transmissions.
You can stop, start, pause, or resume transmission.
| Command | TRANSMISSION START |
| Description | Initiates the transmission pause |
| Syntax | TRANSmission START <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION STOP |
| Description | Stops the transmission pause |
| Syntax | TRANSmission STOP <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION PAUSE |
| Description | Pauses the transmission pause |
| Syntax | TRANSmission PAUSE <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION RESUME |
| Description | Resumes a paused transmission pause |
| Syntax | TRANSmission RESUME <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
You can clear an existing schedule, disable or enable the use of a schedule, and set start, stop, and window criteria.
| Note: | All transmission options are stored on the source machine until they are either cleared or the option is updated. At this time, there is not a command to display the existing transmission options. |
| Command | SCHEDULE CLEAR |
| Description | Clears the existing transmission schedule for the specified target |
| Syntax | SCHEDule <target> CLEAR |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE ENABLE |
| Description | Enables the transmission schedule |
| Syntax | SCHEDule <target> ENABLE |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE DISABLE |
| Description | Disables the transmission schedule without clearing the schedule data |
| Syntax | SCHEDule <target> DISABLE |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE START |
| Description | Sets criteria to start the transmission of data from the source to the target |
| Syntax | SCHEDule <target> START [STARTTIME = <mm/dd/yy> <hh:mm>] [MEMLIMIT = <percent>] [QUEUESIZE = <bytes>] [EVERY <number> <time_units>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SCHEDULE END |
| Description | Sets criteria to end the transmission of data from the source to the target |
| Syntax | SCHEDule <target> END [ DURATION = <number> <time_units> ] [ BYTES = <bytes> ] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SCHEDULE WINDOW |
| Description | Sets criteria to only allow transmissions during a certain period of time |
| Syntax | SCHEDule <target> WINDOW <hh:mm> TO <hh:mm> |
| Options |
|
| Examples |
|
| Notes |
|
This section shows examples of how the different schedule commands could be used together. The numbers and times were randomly selected for these examples. Be sure to use values that work for your environment.
schedule alpha start starttime=1/12/09 22:30, every 1 day
schedule alpha end duration=6 hr
schedule alpha enable
If all the data is not transmitted within the 6-hour duration, the remaining data will remain in the queue and will be transmitted during the next scheduled transmission.
schedule alpha start queuesize=40000000
schedule alpha end bytes=50000000
schedule alpha enable
If there is data remaining in the source queue after the transmission ends, the data will be sent when the source queue again reaches 40000000 bytes of data.
schedule alpha start queuesize=50000000
schedule alpha end bytes=60000000
schedule alpha window 22:00 to 04:00
schedule alpha enable
If additional data remains in the source queue after the transmission ends, that data will be sent when the start criteria is again met within the defined 6-hour window. However, if the start criteria is not met within the defined 6-hour window, data remains in the queue until the start criteria is met within the defined window.
At any time, transmission can be manually started, stopped, paused, or resumed regardless of scheduled transmission criteria.
With a fixed bandwidth limit, data will be transmitted at all times according to the user-specified bandwidth configuration. If you want to set a fixed bandwidth limit, use the
| Command | LIMIT BANDWIDTH |
| Description | Sets a fixed bandwidth limitation for transmitting data from the source to the target |
| Syntax | LIMIT BANDWIDTH <bytes>, <seconds> TO <target> |
| Options |
|
| Examples | limit bandwidth 19300, 5 to beta |
| Notes |
|
| Command | COMPRESSION LIST |
| Description | Identifies the compression level set and if compression is enabled |
| Syntax | COMPRESSion LIST |
| Command | COMPRESSION SET |
| Description | Sets the compression level |
| Syntax | COMPRESSion SET <con_id> <level> |
| Options |
|
| Examples | compression set 1 2 |
| Notes | This command only sets the level of compression. It does not initiate compression. |
| Command | COMPRESSION ENABLE |
| Description | Enables compression |
| Syntax | COMPRESSion ENABLE <con_id> |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | compression enable 1 |
| Command | COMPRESSION DISABLE |
| Description | Disables compression |
| Syntax | COMPRESSion DISABLE <con_id> |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | compression disable 1 |
| Command | LOGIN |
| Description | Log on to a Double-Take Availability machine |
| Syntax | LOGIN <machine> <username> <password> [domain] |
| Options |
|
| Examples | login alpha administrator ****** |
| Notes |
|
| Command | SOURCE |
| Description | Identifies a machine as the active source machine |
| Syntax | SOUrce <source> |
| Options | source—Name of the source |
| Examples |
|
| Notes | Source names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | RESTORE |
| Description | Initiates the restoration process |
| Syntax | RESTORE <repset> FROM <target> ORIGINAL <original_source> [, OVERWRITE | NOOVERWRITE] [, OVERWRITENEWER | NOOVERWRITENEWER] [, USETARGETDB | NOUSETARGETDB] [, RESTOREDBTOO | NORESTOREDBTOO] [, CHECKSUM | NOCHECKSUM][, ORPHANS | NOORPHANS] |
| Options |
|
| Examples | restore DataFiles from beta ,overwritenewer ,usetargetdb |
| Notes |
|
| Command | DISCONNECT |
| Description | Disconnects a specified source/target connection for the currently selected source |
| Syntax | DISCONnect <con_id | *> |
| Options |
|
| Examples |
|
Using the scripting commands, you can perform the following functions to manage failover.
| Command | TARGET |
| Description | Identifies a machine as the active target machine |
| Syntax | TARget <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes |
|
| Command | NICLIST |
| Description | Displays the NICs available on the specified target machine. Each NIC is assigned an integer value and this value is used in the monitor move command. |
| Syntax | NICLIST [target] |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples | niclist beta |
| Notes |
|
| Command | MONITOR CREATE |
| Description | Establishes a source as a failover monitor. This is the machine that will be monitored by a target in case it should experience a failure. |
| Syntax | MONitor CREATE <source> |
| Options | source—Name of the source |
| Examples |
|
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR USE |
| Description | Specifies the source machine designated as the monitor that will be used in subsequent monitor commands |
| Syntax | MONitor USE <monitor> |
| Options | monitor—Name of the source machine designated as the monitor . |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR MOVE |
| Description | Designates the IP address that will be failed over to the specified target NIC |
| Syntax | MONitor MOVE <IP_address> TO NIC <target_NIC> USE NONE | NETWORK INTERVAL <interval> TIMEOUT <timeout> | SERVICE INTERVAL <interval> TIMEOUT <timeout> | <NOTEST> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR REMOVE |
| Description | Removes an IP address that is currently being monitored |
| Syntax | MONitor REMove <IP_address> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR OPTION |
| Description | Configures the settings to determine how failover will be performed |
| Syntax | MONitor OPTION [MOVENAME | NOMOVENAME] [, MOVEADDRESSES | NOMOVEADDRESSES] [, MOVESHARES | NOMOVESHARES] [, ADD | REPLACE] [, USESHAREFILE | NOUSESHAREFILE][, FAILONE | FAILALL] [, FODELAY | NOFODELAY] [, FBDELAY | NOFBDELAY] [, APPLY | DISCARD | REVERT] [, INTERVENTION | NOINTERVENTION] [, FOHOSTNAME | NOFOHOSTNAME] [, FBHOSTNAME | NOFBHOSTNAME] [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR ACCOUNT ADD |
| Description | Identifies a user account with update permissions within Active Directory |
| Syntax | MONitor ACCOUNT ADD <username> <password> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR SCRIPT ADD |
| Description | Specifies the scripts that should be run during the failover and failback processes |
| Syntax | MONitor SCRIPT ADD <type> <script_name> [ARGS=<arguments>] [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR SCRIPT REMOVE |
| Description | Specifies the scripts that should not be run during the failover and failback processes |
| Syntax | MONitor SCRIPT REMove <type> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR DISPLAY |
| Description | Displays the monitoring and failover configuration settings for the specified monitor machine |
| Syntax | MONitor DISPlay <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | MONITOR START |
| Description | Initiates failover monitoring |
| Syntax | MONitor START <monitor> [ON <target>] |
| Options |
|
| Examples |
|
| Notes | Option names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR GET |
| Description | Retrieves and displays the machines that are currently being monitored by the specified target machine |
| Syntax | MONitor GET <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR DISPLAY |
| Description | Displays the monitoring and failover configuration settings for the specified monitor machine |
| Syntax | MONitor DISPlay <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
Verify that the source machine is offline and not connected to the network to avoid IP address
conflicts. Trigger failover using the
| Command | FAILOVER |
| Description | Manually initiates the failover process for the specified monitor machine |
| Syntax | FAILOVER <monitor> [ON <target>] [APPLY | DISCARD | REVERT] |
| Options |
|
| Examples | failover alpha on beta apply |
| Notes | If failover is configured for manual intervention, you must open the Failover Control Center to access the intervention prompt. |
| Command | MONITOR GET |
| Description | Retrieves and displays the machines that are currently being monitored by the specified target machine |
| Syntax | MONitor GET <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR STOP |
| Description | Stops monitoring the source machine for failure |
| Syntax | MONitor STOP <monitor> [ON <target>] |
| Options |
|
| Examples |
|
| Notes | Option names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR GET |
| Description | Retrieves and displays the machines that are currently being monitored by the specified target machine |
| Syntax | MONitor GET <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR DELETE |
| Description | Deletes the specified failover monitor and all of its parameters |
| Syntax | MONitor DELete <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | LOGIN |
| Description | Log on to a Double-Take Availability machine |
| Syntax | LOGIN <machine> <username> <password> [domain] |
| Options |
|
| Examples | login alpha administrator ****** |
| Notes |
|
| Command | TARGET |
| Description | Identifies a machine as the active target machine |
| Syntax | TARget <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes |
|
| Command | MONITOR GET |
| Description | Retrieves and displays the machines that are currently being monitored by the specified target machine |
| Syntax | MONitor GET <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Note: | The source machine must be online and Double-Take Availability must be running to ensure that the source post-failback script can be started. If the source has not completed its boot process, the command to start the script may be lost and the script will not be initiated. |
| Command | FAILBACK |
| Description | Initiates the failback process for the specified monitor machine |
| Syntax | FAILBACK <monitor> [ON <target>] REMONITOR|NOREMONITOR |
| Options |
|
| Examples | failback alpha on beta remonitor |
| Notes | Options that contain non-alphanumeric characters must be enclosed in quotation marks. |
While only a subset of the server settings are available through the Replication Console, all of the Double-Take Availability server settings are accessible through the get and set commands. See Server settings for a complete list of the server settings.
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
The following table lists all of the server settings, in decimal value.
Below are links to sample Double-Take Availability scripts. Most of the sample scripts must be modified. They cannot be used as-is. Modify them to fit your environment. If you need basic assistance with script modifications, contact Technical Support. Assistance with advanced scripting will be referred to Professional Services.
The following script will start a Double-Take Availability connection by creating a replication set called DataFiles on the source alpha and connecting it to the target beta.
|
source alpha; repset create DataFiles; repset rule add c:\files include, recursive; repset rule add c:\files\users exclude; repset rule add d:\data include, recursive; repset save; connect DataFiles to beta map exact; |
The following script will start a Double-Take Availability connection by creating a replication set called DataFiles on the source alpha and connecting it to the target beta. This script will also configure and start failover monitoring.
|
source alpha; repset create DataFiles; repset rule add c:\files include, recursive; repset rule add c:\files\users exclude; repset rule add d:\data include, recursive; repset save; connect DataFiles to beta map exact; target beta; monitor create alpha; monitor move 205.31.4.193 to nic 3 interval 5 timeout 25; monitor start alpha; |
The following script will restore the data in the DataFiles replication set from the target machine beta to the original source machine.
|
source alpha; restore DataFiles to beta nooverwritenewer, usertargetdb; |
The following script uses variables to identify the source, target, and replication set. These variables are then used in the scripting commands. The $connectionID variable will contain the connection ID for the connection established. This variable can then be used to establish a verification schedule.
|
$TheTarget = "beta"; $TheSource = "alpha"; $TheRepset = "DataFiles"; source $TheSource; repset create $TheRepset; repset rule add c:\files include, recursive; repset rule add c:\files\users exclude; repset rule add d:\data include, recursive; repset save; $ConnectionID = connect $TheRepset to $TheTarget map exact; verify $ConnectionID sync, newer, checksum, every 12 hr; |
The following script uses the IF conditional, FOR loop, and WHILE loop commands. In the following examples the FOR loop will start a mirror for all connections between 1 and 10. The IF conditional will return the error command "mirror failed to start" if a value of 0 is not obtained. The WHILE loop will wait for a mirror to end and disconnect as long as the returned value is less than 10. The IF conditional will return the error message "failed to disconnect" if a value of 0 is not obtained.
|
# Start mirror for all connections 1-10. # # Notify user of any errors. # SOURCE alpha; FOR $x = 1 TO 10 DO $ret = MIRROR START $x; IF $ret != 0 THEN WRITE "Mirror failed to start"; WRITE $x; WRITE $ret; END END
# Wait for mirror to end and disconnect all connections 1-10. # # Notify user of any errors. # SOURCE alpha; $x = 1; WHILE $x <= 10 DO waitonmirror $x; $ret = disconnect $X; IF $ret != 0 THEN WRITE "Failed to disconnect"; WRITE $x; WRITE $ret; END $x = $x + 1; END |
The following script uses variables to identify the target and credentials to login to that target. These variables are then used in the scripting commands to pause the target.
|
$TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.com"; login $TheTarget $TheUser $ThePassword $TheDomain; target $TheTarget; pausetarget $TheTarget; |
The following script uses variables to identify the target and credentials to login to that target. These variables are then used in the scripting commands to resume the target.
|
$TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.com"; login $TheTarget $TheUser $ThePassword $TheDomain; target $TheTarget; resumetarget $TheTarget; |
The following script stops the services on the source, pauses the script to allow the source time to write the remaining application data to disk, inserts a Double-Take Availability task command into the Double-Take Availability replication process, and then restarts the services.
|
REM Stop the services on the source so that data changes are stopped. net stop "Service Name 1" net stop "Service Name 2" net stop "Service Name 3" net stop "Service Name 4"
REM Pause the source (for a specified number of seconds) to allow time for REM the application data to be written to disk. The sleep command is available REM from the Windows Resource Kit. sleep 120
REM At this point the source application is stable (service is stopped and data REM is written). Now, initiate your Double-Take Availability task command, for example to REM trigger a snapshot or backup. The process you want to run on the target REM must be contained in the batch file specified in the queuetask command. REM That batch file must be stored on the target so that it can be executed REM on the target. C:\Program Files\DoubleTake\dtcl $TheSource = "alpha" C:\Program Files\DoubleTake\dtcl $TheTarget = "beta" C:\Program Files\DoubleTake\dtcl $TheUserName = "administrator" C:\Program Files\DoubleTake\dtcl $ThePassword = "password" C:\Program Files\DoubleTake\dtcl $TheDomain = "domain.com" C:\Program Files\DoubleTake\dtcl login $TheSource $TheUserName $ThePassword $TheDomainName C:\Program Files\DoubleTake\dtcl login $TheTarget $TheUserName $ThePassword $TheDomainName C:\Program Files\DoubleTake\dtcl queuetask backup to $TheTarget onexecute=Backup.bat timeout=forever
REM Now that the task command has been inserted inline with Double-Take Availability replication, the REM services can be restarted. New changes to the data will fall inline behind the task REM command just inserted. net start "Service Name 1" net start "Service Name 2" net start "Service Name 3" net start "Service Name 4" |
The following two scripts create multiple copies of your data on the target, but only one copy is active at a time. This allows you the time and availability to backup the inactive copy of data. This is especially helpful when you have applications with interdependent files.
Backups occur sequentially from the first file to the last file. Therefore, when you are using applications that have interdependent files, such as a database application whose database and log files must be synchronized, Double-Take Availability cannot be actively updating files on the target while the backup is running, or there becomes an opportunity for interdependent files to become mismatched, causing a corrupt application on the backup. For example, suppose the following scenario occurs on a target machine that contains a replica of a database.
At this point, the database file on the tape backup contains an extra update that the log file on the tape backup does not. The two files do not correspond, so the database on the tape backup will not be time consistent.
The two scripts identify an existing connection, disconnect it, establish a new connection, and initiate a difference mirror. The connections in the two scripts transmit the same data to two different locations, allowing you to backup the idle files on the inactive connection.
|
# Script 1 # $TheSource = "alpha"; $TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.com"; $TheRepSet = "DataFiles"; login $TheSource $TheUser $ThePassword $TheDomain; login $TheTarget $TheUser $ThePassword $TheDomain; source $TheSource; $FirstConnection = conid $TheRepSet to $TheTarget map base c:\first_location; disconnect $FirstConnection; $SecondConnection = connect $TheRepSet to $TheTarget map base c:\second_location, nomirror; mirror start $SecondConnection different, checksum; |
|
# Script 2 # $TheSource = "alpha"; $TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.com"; $TheRepSet = "DataFiles"; login $TheSource $TheUser $ThePassword $TheDomain; login $TheTarget $TheUser $ThePassword $TheDomain; source $TheSource; $SecondConnection = conid $TheRepSet to $TheTarget map base c:\second_location; disconnect $SecondConnection; $FirstConnection = connect $TheRepSet to $TheTarget map base c:\first_location, nomirror; mirror start $FirstConnection different, checksum; |
Each scripting command includes the following.
For details on the conventions used for the command syntax, see Command syntax conventions.
| Command | COMPRESSION DISABLE |
| Description | Disables compression |
| Syntax | COMPRESSion DISABLE <con_id> |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | compression disable 1 |
| Command | COMPRESSION ENABLE |
| Description | Enables compression |
| Syntax | COMPRESSion ENABLE <con_id> |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | compression enable 1 |
| Command | COMPRESSION LIST |
| Description | Identifies the compression level set and if compression is enabled |
| Syntax | COMPRESSion LIST |
| Command | COMPRESSION SET |
| Description | Sets the compression level |
| Syntax | COMPRESSion SET <con_id> <level> |
| Options |
|
| Examples | compression set 1 2 |
| Notes | This command only sets the level of compression. It does not initiate compression. |
| Command | CONID |
| Description |
|
| Syntax |
|
| Options |
|
| Examples |
|
| Notes |
|
| Command | CONNECT |
| Description | Establishes a connection between a replication set and a target machine |
| Syntax | CONnect <repset> TO <target> MAP EXACT | MAP BASE <target_path> | MAP <source_path> TO <target_path> [,...] [MIRror | NOMIRror] [, REPlicate | NOREPlicate] [, MONitor | NOMONitor] [, ORPHANS | NOORPHANS] [, COMPRESSion <level>] [CLEARRESTOREREQUIRED] [ROUTE=<target_IP>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | CONNECT TDU |
| Description | Establishes a simulation connection between a replication set and the Throughput Diagnostics Utility. This connection imitate a normal connection without transmitting any data across the network. |
| Syntax | CONNECT <repset> TO TDU <filename> [connection_flags] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | DEVICE LIST |
| Description | Displays the block devices available on a machine |
| Syntax | DEVICE LIST <filter> [ON <machine>] |
| Options |
|
| Examples |
device list all on alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | DISCONNECT |
| Description | Disconnects a specified source/target connection for the currently selected source |
| Syntax | DISCONnect <con_id | *> |
| Options |
|
| Examples |
|
| Command | EMAIL ADD |
| Description | Adds an e-mail address to the e-mail notification distribution list |
| Syntax | EMAIL ADD <email_address> |
| Options | email_address—A valid e-mail address enclosed in quotation marks |
| Examples | email add "administrator@domain.com" |
| Notes |
|
| Command | EMAIL DISABLE |
| Description | Disables e-mail notification |
| Syntax | EMAIL DISABLE |
| Options | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL ENABLE |
| Description | Enables e-mail notification |
| Syntax | EMAIL ENABLE |
| Options | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL FILTER |
| Description | Displays the filter configuration from the email setfilterinclude command |
| Syntax | EMAIL FILTER |
| Options | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL FROMADDRESS |
| Description | Specifies the e-mail address that will appear in the From field of Double-Take Availability generated e-mail messages |
| Syntax | EMAIL FROMADDRESS <email_address> |
| Options | email_address—A valid e-mail address enclosed in quotation marks |
| Examples | email fromaddress "administrator@domain.com" |
| Notes | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL GET EMAILCONFIG |
| Description | Displays e-mail notification configuration information |
| Syntax | EMAIL GET EMAILCONFIG |
| Notes | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL MAILSERVER |
| Description | Specifies the name of the SMTP mail server for e-mail notification |
| Syntax | EMAIL MAILSERVER <server_name | ip_address> [username][password] |
| Options |
|
| Examples | email mailserver xchng administrator ******* |
| Notes |
|
| Command | EMAIL REMOVE |
| Description | Removes an e-mail address from the e-mail notification distribution list |
| Syntax | EMAIL REMOVE <email_address> |
| Options | email_address—An e-mail address, listed in the current distribution list, enclosed in quotation marks |
| Examples | email remove "administrator@domain.com" |
| Notes | You must have an active source specified for any e-mail command to work properly. |
| Command | EMAIL SETFILTERINCLUDE |
| Description | Specifies which Event Viewer messages are sent via e-mail |
| Syntax | EMAIL SETFILTERINCLUDE [INFO, WARNING, ERROR] [EXCLUDEIDS "<ID1,ID2-ID4,...>"] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | EMAIL SUBJECT |
| Description | Specifies if additional text will be displayed in the subject of the e-mail message |
| Syntax | EMAIL SUBJECT [PREFIX <prefix> | NOPREFIX] [DESCRIPTION | NODESCRIPTION] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | EMAIL TEST |
| Description | Sends a test message to demonstrate e-mail notification |
| Syntax | EMAIL TEST [SENDTO <email_address[,email_address,...]>] [TEXT <message_text>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | ENVIRONMENT |
| Description | Displays a list of all Double-Take Availability machines available to the specified machine. Each machine is identified by machine name, IP addresses and whether or not the source and/or target modules are loaded. If no machine is specified, the information is provided for the machine currently specified as the source. |
| Syntax | ENVironment [machine] |
| Options | machine—Name of the machine to poll for environment information |
| Examples |
|
| Command | EXIT |
| Description | Exits the Command Line Interactive client |
| Syntax | EXIT |
| Command | FAILBACK |
| Description | Initiates the failback process for the specified monitor machine |
| Syntax | FAILBACK <monitor> [ON <target>] REMONITOR|NOREMONITOR |
| Options |
|
| Examples | failback alpha on beta remonitor |
| Notes | Options that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | FAILOVER |
| Description | Manually initiates the failover process for the specified monitor machine |
| Syntax | FAILOVER <monitor> [ON <target>] [APPLY | DISCARD | REVERT] |
| Options |
|
| Examples | failover alpha on beta apply |
| Notes | If failover is configured for manual intervention, you must open the Failover Control Center to access the intervention prompt. |
| Command | GET |
| Description | Requests the value of a Double-Take Availability program setting from the specified server |
| Syntax | GET <setting> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | GETENVSTR |
| Description | Retrieves an operating system environment variable and stores the value in a Double-Take Availability variable |
| Syntax | GETENVSTR <env_variable> $<variable_name> |
| Options |
|
| Examples | getenvstr computername $server |
| Notes | It is not necessary for either the environment or Double-Take Availability variable to exist when using this command. A non-existent environment variable will store a null string in the Double-Take Availability variable. |
| Command | GETLOCAL |
| Description | Requests the value of a Double-Take Availability program setting from the local machine |
| Syntax | GETLOCAL <setting> |
| Options | setting—See Server settings for a complete list of the Double-Take Availability program settings |
| Examples |
|
| Command | HELP |
| Description | Displays the DTCL commands and their syntax |
| Syntax | HELP |
| Notes |
|
| Command | LIMIT BANDWIDTH |
| Description | Sets a fixed bandwidth limitation for transmitting data from the source to the target |
| Syntax | LIMIT BANDWIDTH <bytes>, <seconds> TO <target> |
| Options |
|
| Examples | limit bandwidth 19300, 5 to beta |
| Notes |
|
| Command | LOAD SOURCE |
| Description | Loads the Double-Take Availability source module |
| Syntax | LOAD SOURCE <machine> |
| Options | machine—Name of the machine |
| Examples | load source alpha |
| Notes | Machine names that contain non-alphanumeric characters should be enclosed in quotation marks. |
| Command | LOAD TARGET |
| Description | Loads the Double-Take Availability target module |
| Syntax | LOAD TARGET <machine> |
| Options | machine—Name of the machine |
| Examples | load target beta |
| Notes | Machine names that contain non-alphanumeric characters should be enclosed in quotation marks. |
| Command | LOGIN |
| Description | Log on to a Double-Take Availability machine |
| Syntax | LOGIN <machine> <username> <password> [domain] |
| Options |
|
| Examples | login alpha administrator ****** |
| Notes |
|
| Command | LOGOUT |
| Description | Logs off of a Double-Take Availability machine |
| Syntax | LOGOUT <machine> |
| Options | machine—Name of the machine |
| Examples | logout alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MIRROR PAUSE |
| Description | Pauses a mirror that is in progress |
| Syntax | MIRror PAUSE <con_id | *> |
| Options |
|
| Examples |
|
| Command | MIRROR RESUME |
| Description | Resumes a paused mirror |
| Syntax | MIRror RESUME <con_id | *> |
| Options |
|
| Examples |
|
| Command | MIRROR START |
| Description | Initiates the mirror process |
| Syntax | MIRror START <con_id> [DIFFERENT [,NEWER] ,CHECKSUM | NOCHECKSUM] [ORPHANS |NOORPHANS] [CALCulate | NOCALCulate] [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
| Notes | The default settings for this command are noorphans and calculate. |
| Command | MIRROR STOP |
| Description | Stops a mirror |
| Syntax | MIRror STOP <con_id | *> |
| Options |
|
| Examples |
|
| Command | MONITOR ACCOUNT ADD |
| Description | Identifies a user account with update permissions within Active Directory |
| Syntax | MONitor ACCOUNT ADD <username> <password> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR ACCOUNT REMOVE |
| Description | Removes the user account used to failover Active Directory |
| Syntax | MONitor ACCOUNT REMove <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | MONITOR CLEAR |
| Description | Clears all of the failover configuration and monitoring parameters for the specified monitor machine |
| Syntax | MONitor CLEAR [monitor] |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | MONITOR CREATE |
| Description | Establishes a source as a failover monitor. This is the machine that will be monitored by a target in case it should experience a failure. |
| Syntax | MONitor CREATE <source> |
| Options | source—Name of the source |
| Examples |
|
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR DELETE |
| Description | Deletes the specified failover monitor and all of its parameters |
| Syntax | MONitor DELete <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | MONITOR DISPLAY |
| Description | Displays the monitoring and failover configuration settings for the specified monitor machine |
| Syntax | MONitor DISPlay <monitor> |
| Options | monitor—Name of the source machine designated as the monitor |
| Examples |
|
| Notes |
|
| Command | MONITOR GET |
| Description | Retrieves and displays the machines that are currently being monitored by the specified target machine |
| Syntax | MONitor GET <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR LIST |
| Description | Displays a list of all failover monitor machines |
| Syntax | MONitor LIST |
| Examples |
|
| Command | MONITOR MOVE |
| Description | Designates the IP address that will be failed over to the specified target NIC |
| Syntax | MONitor MOVE <IP_address> TO NIC <target_NIC> USE NONE | NETWORK INTERVAL <interval> TIMEOUT <timeout> | SERVICE INTERVAL <interval> TIMEOUT <timeout> | <NOTEST> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR OPTION |
| Description | Configures the settings to determine how failover will be performed |
| Syntax | MONitor OPTION [MOVENAME | NOMOVENAME] [, MOVEADDRESSES | NOMOVEADDRESSES] [, MOVESHARES | NOMOVESHARES] [, ADD | REPLACE] [, USESHAREFILE | NOUSESHAREFILE][, FAILONE | FAILALL] [, FODELAY | NOFODELAY] [, FBDELAY | NOFBDELAY] [, APPLY | DISCARD | REVERT] [, INTERVENTION | NOINTERVENTION] [, FOHOSTNAME | NOFOHOSTNAME] [, FBHOSTNAME | NOFBHOSTNAME] [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR REMOVE |
| Description | Removes an IP address that is currently being monitored |
| Syntax | MONitor REMove <IP_address> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR SCRIPT ADD |
| Description | Specifies the scripts that should be run during the failover and failback processes |
| Syntax | MONitor SCRIPT ADD <type> <script_name> [ARGS=<arguments>] [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR SCRIPT REMOVE |
| Description | Specifies the scripts that should not be run during the failover and failback processes |
| Syntax | MONitor SCRIPT REMove <type> [monitor] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | MONITOR START |
| Description | Initiates failover monitoring |
| Syntax | MONitor START <monitor> [ON <target>] |
| Options |
|
| Examples |
|
| Notes | Option names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR STOP |
| Description | Stops monitoring the source machine for failure |
| Syntax | MONitor STOP <monitor> [ON <target>] |
| Options |
|
| Examples |
|
| Notes | Option names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | MONITOR USE |
| Description | Specifies the source machine designated as the monitor that will be used in subsequent monitor commands |
| Syntax | MONitor USE <monitor> |
| Options | monitor—Name of the source machine designated as the monitor . |
| Examples |
|
| Notes | Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | NICLIST |
| Description | Displays the NICs available on the specified target machine. Each NIC is assigned an integer value and this value is used in the monitor move command. |
| Syntax | NICLIST [target] |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples | niclist beta |
| Notes |
|
| Command | ORPHANS DISABLE |
| Description | Disables orphan file removal during subsequent mirror or verification processes. |
| Syntax | ORPHANS DISABLE con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans disable 1 |
| Command | ORPHANS ENABLE |
| Description | Enables orphan file removal during subsequent mirror or verification processes. |
| Syntax | ORPHANS ENABLE con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans enable 1 |
| Command | ORPHANS START |
| Description | Manual operation to remove any orphan files on the target |
| Syntax | ORPHANS START con_id [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples | orphans start 1 |
| Command | ORPHANS STOP |
| Description | Stops the process to remove orphan files on the target |
| Syntax | ORPHANS STOP con_id |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | orphans stop 1 |
| Command | PAUSE TARGET |
| Description | Allows you to pause the execution of Double-Take Availability operations on the target |
| Syntax | PAUSETARGET <target> [FROM <source>] |
| Options |
|
| Examples | pausetarget beta |
| Notes |
|
| Command | PING |
| Description | Checks a specified machine to see if Double-Take Availability is running |
| Syntax | PING <machine> |
| Options | machine—Name of the machine |
| Examples | ping alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | QUEUETASK |
| Description | Queues tasks inline with replication data |
| Syntax | QueueTASK <job_name> TO <target> ONQueue = <task> [args] | ONTRANSmit = <task> [args] | ONRECeive = <task> [args] | ONEXECute = <task> [args] [TIMEOUT = <timeout>] [INTERACT | NOINTERACT] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | QUIT |
| Description | Quits the Command Line Interactive client |
| Syntax | QUIT |
| Command | REPLICATION START |
| Description | Initiates the replication process |
| Syntax | REPlication START <conid | *> [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
| Command | REPLICATION STOP |
| Description | Stops the replication process |
| Syntax | REPLlication STOP <conid | *> |
| Options |
|
| Examples |
|
| Command | REPSET CALCULATE |
| Description | Calculates the size of a replication set |
| Syntax | REPSET CALCulate [repset] |
| Options | repset—Name of the replication set |
| Examples |
|
| Notes |
|
| Command | REPSET CREATE |
| Description | Creates a replication set |
| Syntax | REPSET CREATE <name> |
| Options | name—Name of the replication set |
| Examples | repset create DataFiles |
| Notes |
|
| Command | REPSET DELETE |
| Description | Deletes the specified replication set |
| Syntax | REPSET DELete <repset> |
| Options | repset—Name of the replication set repset |
| Examples |
|
| Notes | Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | REPSET DISPLAY |
| Description | Displays the replication set rules |
| Syntax | REPSET DISPlay [repset] |
| Options | repset—Name of the replication set |
| Examples |
|
| Notes |
|
| Command | REPSET LIST |
| Description | Lists all replication set names for the currently selected source |
| Syntax | REPSET LIST |
| Command | REPSET RESYNC |
| Description | Retrieves the last saved replication set settings, clearing any unsaved changes |
| Syntax | REPSET RESYNC |
| Command | REPSET RULE ADD |
| Description | Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names. |
| Syntax | REPSET RULE ADD <path> [INClude|EXClude] [, RECursive|NONRECursive] [TO <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | REPSET RULE REMOVE |
| Description | Removes a rule from a replication set |
| Syntax | REPSET RULE REMove <path> [FROM <repset>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | REPSET SAVE |
| Description | Saves all replication set rules for the currently selected source |
| Syntax | REPSET SAVE |
| Command | REPSET USE |
| Description | Specifies a replication set as the active replication set |
| Syntax | REPSET USE <repset> |
| Options | repset—Name of the replication set |
| Examples | repset use DataFiles |
| Notes | Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | RESTORE |
| Description | Initiates the restoration process |
| Syntax | RESTORE <repset> FROM <target> ORIGINAL <original_source> [, OVERWRITE | NOOVERWRITE] [, OVERWRITENEWER | NOOVERWRITENEWER] [, USETARGETDB | NOUSETARGETDB] [, RESTOREDBTOO | NORESTOREDBTOO] [, CHECKSUM | NOCHECKSUM][, ORPHANS | NOORPHANS] |
| Options |
|
| Examples | restore DataFiles from beta ,overwritenewer ,usetargetdb |
| Notes |
|
| Command | RESUME TARGET |
| Description | Allows you to resume the execution of Double-Take Availability operations on the target |
| Syntax | RESUMETARGET <target> [FROM <source>] |
| Options |
|
| Examples | resumetarget beta |
| Notes |
|
| Command | SCHEDULE CLEAR |
| Description | Clears the existing transmission schedule for the specified target |
| Syntax | SCHEDule <target> CLEAR |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE DISABLE |
| Description | Disables the transmission schedule without clearing the schedule data |
| Syntax | SCHEDule <target> DISABLE |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE ENABLE |
| Description | Enables the transmission schedule |
| Syntax | SCHEDule <target> ENABLE |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SCHEDULE END |
| Description | Sets criteria to end the transmission of data from the source to the target |
| Syntax | SCHEDule <target> END [ DURATION = <number> <time_units> ] [ BYTES = <bytes> ] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SCHEDULE START |
| Description | Sets criteria to start the transmission of data from the source to the target |
| Syntax | SCHEDule <target> START [STARTTIME = <mm/dd/yy> <hh:mm>] [MEMLIMIT = <percent>] [QUEUESIZE = <bytes>] [EVERY <number> <time_units>] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SCHEDULE WINDOW |
| Description | Sets criteria to only allow transmissions during a certain period of time |
| Syntax | SCHEDule <target> WINDOW <hh:mm> TO <hh:mm> |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET |
| Description | Modifies the value of a Double-Take Availability program setting for the specified server |
| Syntax | SET <setting>=<value> [machine] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SET LOCAL |
| Description | Modifies the value of a Double-Take Availability program setting for the local machine |
| Syntax | SETLOCAL <setting>=<value> |
| Options |
|
| Examples |
|
| Notes |
|
| Command | SHUTDOWN |
| Description | Stops the Double-Take service . |
| Syntax | SHUTDOWN <machine> |
| Options | machine—Name of the machine |
| Examples | shutdown alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | SOURCE |
| Description | Identifies a machine as the active source machine |
| Syntax | SOUrce <source> |
| Options | source—Name of the source |
| Examples |
|
| Notes | Source names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | STATSLOG START |
| Description | Starts the DTStats statistics logging utility |
| Syntax | STATSLOG START <machine> [TO <filename>] [EVERY <minute>] [MAXSIZE <kilobytes>] |
| Options |
|
| Examples | statslog start alpha to "dtstat.sts" every 20 maxsize 200000 |
| Notes |
|
| Command | STATSLOG STATUS |
| Description | Identifies whether the DTStats statistics logging utility is currently running |
| Syntax | STATSLOG STATUS <machine> |
| Options | machine—Name of the machine |
| Examples | statslog status alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | STATSLOG STOP |
| Description | Stops the DTStats statistics logging utility |
| Syntax | STATSLOG STOP <machine> |
| Options | machine—Name of the machine |
| Examples | statslog stop alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | STATUS |
| Description | Requests connection and statistical information |
| Syntax | STATUS BLOCK [ON <target>] | CONnect <con_id> | MIRror <con_id> | REPlicate <con_id> | TRANsmit <con_id> |
| Options |
|
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TARGET |
| Description | Identifies a machine as the active target machine |
| Syntax | TARget <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address |
| Examples |
|
| Notes |
|
| Command | TEST CONNECTIONS |
| Description | Sends a test command to determine if Double-Take Availability is running. If there are active connections, the replication set(s), IP address(es), and connection ID(s) will be included in the testcon log file. |
| Syntax | TESTCONnections <machine> [ filename [OVERWRITE]] |
| Options |
|
| Examples |
|
| Notes |
|
| Command | TIME NOW |
| Description | Prints the current date and time. This command is useful for scripting to determine process start and stop times. |
| Syntax | TIMEnow |
| Examples |
|
| Command | TRANSMISSION PAUSE |
| Description | Pauses the transmission pause |
| Syntax | TRANSmission PAUSE <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION RESUME |
| Description | Resumes a paused transmission pause |
| Syntax | TRANSmission RESUME <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION START |
| Description | Initiates the transmission pause |
| Syntax | TRANSmission START <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | TRANSMISSION STOP |
| Description | Stops the transmission pause |
| Syntax | TRANSmission STOP <target> |
| Options | target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Double-Take Availability uses to access the target, you may need to specify the fully qualified domain name. |
| Examples |
|
| Notes | Target names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | UNLOAD SOURCE |
| Description | Unloads the Double-Take Availability source module |
| Syntax | UNLOAD SOURCE <machine> |
| Options | machine—Name of the machine |
| Examples | unload source alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | UNLOAD TARGET |
| Description | Unloads the Double-Take Availability target module |
| Syntax | UNLOAD TARGET <machine> |
| Options | machine—Name of the machine |
| Examples | unload target alpha |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | VERIFY |
| Description | Verifies the integrity of the data between the source and target machines |
| Syntax | VERIFY <con_id> [ SYNC [,NEWER] | NOSYNC] [,CHECKSUM | NOCHECKSUM] [STARTTIME=<mm/dd/yy> [hh:mm]] [EVERY <number> <time_units>] [ORPHANS | NOORPHANS] [CLEARRESTOREREQUIRED] |
| Options |
|
| Examples |
|
| Notes | The default verification settings are sync, checksum, and noorphans. |
| Command | VERSION |
| Description | Displays the Double-Take Availability version currently installed |
| Syntax | VERSION [MACHINE] |
| Options | MACHINE—Name of the machine |
| Examples | version alpha |
| Notes |
|
| Command | WAIT |
| Description | This command is used in scripts to force the script to stop executing until the specified number of milliseconds has elapsed. |
| Syntax | WAIT <ms> |
| Options | ms—Length of time in milliseconds |
| Examples | wait 5000 |
| Notes | This sample waits for 5 seconds. |
| Command | WAIT ON MIRROR |
| Description | This command is used in scripts to force the script to stop executing until the connection has finished mirroring or verifying |
| Syntax | WAITONMIRROR <con_id> |
| Options | con_id—Connection ID assigned to the source/target connection |
| Examples | waitonmirror 1 |
| Command | WAIT ON RESTORE |
| Description | This command is used in scripts to force the script to stop executing until the connection has finished restoring |
| Syntax | WAITONRESTORE <rest_id> |
| Options | rest_id—Restoration ID assigned to the source/target connection |
| Examples | waitonrestore 1 |
| Notes | This command requires using the source command immediately before the waitonrestore command. |
| Command | WAIT ON TARGET |
| Description | This command is used in scripts to force the script to stop executing until the target queue has been empty for the time specified |
| Syntax | WAITONTARGET <target> [FROM <source>] <time> |
| Options |
|
| Examples | waitontarget beta from alpha 30 |
| Notes | Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. |
| Command | WRITE |
| Description | Displays the value of a Double-Take Availability variable |
| Syntax | WRITE $<variable_name> |
| Options | variable_name—The name of the variable that you have established and want to display |
| Examples |
|